VIVE 3DSP Native C Library  ver 1.0.0.0
Audio 3DSP (3D Sound Perception) Native C Library
audio_engine.h
Go to the documentation of this file.
1 //========= Copyright 2016-2018, HTC Corporation. All rights reserved. ===========
2 #pragma once
3 #ifdef _VIVE_3DSP_API_DLLEXPORT_
4 #define VIVE_3DSP_API_DLLEXPORT __declspec(dllexport)
5 #else
6 #define VIVE_3DSP_API_DLLEXPORT __declspec(dllimport)
7 #endif
8 
9 #ifdef __cplusplus
10 extern "C" {
11 #endif
12 namespace HTC_Vive3DSP_SDK {
13  static const double kPI = 3.14159265358979323846;
14  static const double kRadiusToDegreeCoef = 180.0 / kPI;
15  static const int kMaxBufferSize = 4096;
16 
22  typedef struct vive_3dsp_context_ vive_3dsp_context;
23 
27  Status_Error = -1,
36  };
37 
40 
46  };
47 
66  };
75  };
78  ROOM_FLOOR = 0,
84  };
85 
88  {
91  /*RaycastOcclusion*/
92  };
93 
96  {
99  };
100 
114  };
115 
120  };
121 
124  {
129  };
130 
133  {
138  };
139 
145  float x;
146  float y;
147  float z;
150  VIVE_3DSP_Vector3 operator* (const float &a);
151  VIVE_3DSP_Vector3 operator/ (const float &a);
152  static float Dot(VIVE_3DSP_Vector3 a, VIVE_3DSP_Vector3 b);
153  static float Mag(VIVE_3DSP_Vector3 a);
154  bool equals(VIVE_3DSP_Vector3 a);
155  };
159  float x;
160  float y;
161  float z;
162  float w;
167  };
172  };
174  class Countdowner {
175  private:
176  int m_total_cnt;
177  int m_current_cnt;
178  public:
179  Countdowner()
180  : m_total_cnt(10)
181  , m_current_cnt(10)
182  { }
183  Countdowner(int c)
184  : m_total_cnt(c)
185  , m_current_cnt(c)
186  { }
187  ~Countdowner() {};
188 
189  void reset() { m_current_cnt = m_total_cnt; }
190  void set_ticks(int c) { m_total_cnt = c; }
191  int pop() { return m_current_cnt; }
192 
193  bool gostep()
194  {
195  if (--m_current_cnt <= 0)
196  {
197  m_current_cnt = m_total_cnt;
198  return true;
199  }
200  else
201  return false;
202  }
203  };
205  /*****************************************************************************************************************/
206  /* Audio engine */
207  /*****************************************************************************************************************/
208 
218  vive_3dsp_audio_create(vive_3dsp_context **api);
226  vive_3dsp_audio_destroy(vive_3dsp_context **api);
227 
228 
230  /*****************************************************************************************************************/
231  /* Internal functions */
232  /*****************************************************************************************************************/
233  void vive_3dsp_internal_CartesianToSpherical(VIVE_3DSP_Vector3 cartCoords, float *theta, float *phi, float *distance);
234  void vive_3dsp_internal_GetLocalTransform(VIVE_3DSP_Vector3 earPos, VIVE_3DSP_Quaternion earRot,
235  VIVE_3DSP_Vector3 srcPos, VIVE_3DSP_Quaternion srcRot, VIVE_3DSP_Vector3 *localPos, VIVE_3DSP_Quaternion *localRot);
236  void vive_3dsp_internal_downmix(VIVE_3DSP_CHANNELTYPE type, float *in_buffer, float *out_buffer, int sampleLength);
238 }
239 #ifdef __cplusplus
240 }
241 #endif
int VIVE_3DSP_OCCLUSION_CHANNEL_ID
Definition: audio_engine.h:39
Definition: audio_engine.h:54
VIVE_3DSP_Vector3 operator*(const float &a)
Definition: audio_engine.h:118
Definition: audio_engine.h:62
float x
Definition: audio_engine.h:159
Definition: audio_engine.h:158
Definition: audio_engine.h:144
Definition: audio_engine.h:72
Definition: audio_engine.h:89
static float Mag(VIVE_3DSP_Vector3 a)
Definition: audio_engine.h:43
Definition: audio_engine.h:52
Definition: audio_engine.h:69
VIVE_3DSP_ROOM_PLANE
Definition: audio_engine.h:77
Definition: audio_engine.h:110
VIVE_3DSP_API_STATUS
Definition: audio_engine.h:25
VIVE_3DSP_Vector3 operator-(const VIVE_3DSP_Vector3 &a)
#define VIVE_3DSP_API_DLLEXPORT
Definition: audio_engine.h:6
VIVE_3DSP_Vector3 operator*(const VIVE_3DSP_Vector3 &a)
Definition: audio_engine.h:127
float y
Definition: audio_engine.h:146
float y
Definition: audio_engine.h:160
Definition: audio_engine.h:103
Definition: audio_engine.h:57
VIVE_3DSP_REVERB_MODEL
Definition: audio_engine.h:87
VIVE_3DSP_OCC_MATERIAL
Definition: audio_engine.h:102
Definition: audio_engine.h:53
Definition: audio_engine.h:112
VIVE_3DSP_Vector3 operator+(const VIVE_3DSP_Vector3 &a)
VIVE_3DSP_OCCLUSION_COMPUTE_ENGINE
Definition: audio_engine.h:132
Definition: audio_engine.h:106
VIVE_3DSP_Quaternion rotation
Definition: audio_engine.h:170
Definition: audio_engine.h:55
Definition: audio_engine.h:65
Definition: audio_engine.h:27
Definition: audio_engine.h:60
Definition: audio_engine.h:30
Definition: audio_engine.h:64
Definition: audio_engine.h:59
Definition: audio_engine.h:70
Definition: audio_engine.h:44
VIVE_3DSP_Vector3 position
Definition: audio_engine.h:169
VIVE_3DSP_CHANNELTYPE
Definition: audio_engine.h:42
Definition: audio_engine.h:119
Definition: audio_engine.h:63
Definition: audio_engine.h:82
bool equals(VIVE_3DSP_Quaternion a)
VIVE_3DSP_ROOM_REVERB_PRESET
Definition: audio_engine.h:68
VIVE_3DSP_Vector3 operator/(const float &a)
Definition: audio_engine.h:79
bool equals(VIVE_3DSP_Vector3 a)
VIVE_3DSP_Vector3 size
Definition: audio_engine.h:171
Definition: audio_engine.h:71
static float Dot(VIVE_3DSP_Vector3 a, VIVE_3DSP_Vector3 b)
Definition: audio_engine.h:104
Definition: audio_engine.h:168
Definition: audio_engine.h:90
Definition: audio_engine.h:137
Definition: audio_engine.h:97
Definition: audio_engine.h:107
Definition: audio_engine.h:80
VIVE_3DSP_HEADSET_MODEL
Definition: audio_engine.h:117
The vive_3dsp_context structure represents the overall audio engine of 3D sound model.
Definition: audio_engine.h:111
Definition: vive_3dsp_api.h:15
Definition: audio_engine.h:81
Definition: audio_engine.h:78
VIVE_3DSP_OCCLUSION_ENGINE
Definition: audio_engine.h:123
VIVE_3DSP_REVERB_MATERIAL
Definition: audio_engine.h:51
Definition: audio_engine.h:108
Definition: audio_engine.h:73
Definition: audio_engine.h:98
Definition: audio_engine.h:134
static VIVE_3DSP_Quaternion Inverse(VIVE_3DSP_Quaternion rot)
Definition: audio_engine.h:125
Definition: audio_engine.h:34
float w
Definition: audio_engine.h:162
Definition: audio_engine.h:136
VIVE_3DSP_BINAURAL_REVERB_ENGINE
Definition: audio_engine.h:95
Definition: audio_engine.h:126
Definition: audio_engine.h:113
Definition: audio_engine.h:58
Definition: audio_engine.h:74
Definition: audio_engine.h:61
Definition: audio_engine.h:56
Definition: audio_engine.h:83
Definition: audio_engine.h:26
Definition: audio_engine.h:105
float z
Definition: audio_engine.h:161
Definition: audio_engine.h:135
float z
Definition: audio_engine.h:147
float x
Definition: audio_engine.h:145